| Package | hl7.fhir.us.covid19library |
| Type | StructureDefinition |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/covid19library/https://build.fhir.org/ig/HL7/fhir-COVID19Library-ig/StructureDefinition-SARSCoV2AbIgAplusIgMPrThrPtSerPlasordIA.html |
| Url | http://hl7.org/fhir/us/covid19library/StructureDefinition/SARSCoV2AbIgAplusIgMPrThrPtSerPlasordIA |
| Version | 1.0.0 |
| Status | active |
| Date | 2022-07-25T12:22:40+00:00 |
| Name | SARSCoV2AbIgAplusIgMPrThrPtSerPlasordIA |
| Title | SARS-CoV-2 (COVID19) IgA + IgM [Presence] in Serum or Plasma by Immunoassay |
| Experimental | False |
| Realm | us |
| Authority | hl7 |
| Description | SARSCoV2AbIgAplusIgMPrThrPtSerPlasordIA is a qualitative test for the SARS-CoV-2 (COVID19) IgA or IgM antibodies via immunoassay in serum or plasma specimens. |
| Copyright | HL7 International & Logica Health, all rights reserved Creative Commons License |
| Type | Observation |
| Kind | resource |
No resources found
| StructureDefinition | |
c19-coded-laboratory-observation-base  | Coded Laboratory Observation Base |
| http://hl7.org/fhir/us/covid19library/ValueSet/covid19-pos-neg-eqvs | Positive/Negative Value Set |
Note: links and images are rebased to the (stated) source
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | CodedLaboratoryObservationBase | Measurements and simple assertions | |
  code | 1..1 | CodeableConcept | Laboratory Test Name Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 95125-1 | |
| valueCodeableConcept | 0..1 | CodeableConcept | Result Value Binding: Positive/Negative Value Set (extensible) | |
| Documentation for this format | ||||
FHIR{
"resourceType" : "StructureDefinition",
"id" : "SARSCoV2AbIgAplusIgMPrThrPtSerPlasordIA",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Minimum and Maximum # of times the the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/R4/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-SARSCoV2AbIgAplusIgMPrThrPtSerPlasordIA-definitions.html#Observation\">Observation</a><a name=\"Observation\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-c19-coded-laboratory-observation-base.html\">CodedLaboratoryObservationBase</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Measurements and simple assertions</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-SARSCoV2AbIgAplusIgMPrThrPtSerPlasordIA-definitions.html#Observation.code\">code</a><a name=\"Observation.code\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">1</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Laboratory Test Name</span><br/><span style=\"font-weight:bold\">Required Pattern: </span><span style=\"color: darkgreen\">At least the following</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck101.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_fixed.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Fixed Value\" class=\"hierarchy\"/> <a href=\"http://hl7.org/fhir/R4/datatypes-definitions.html#CodeableConcept.coding\">coding</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Code defined by a terminology system<br/><span style=\"font-weight: bold\">Fixed Value: </span><span style=\"color: darkgreen\">(complex)</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1010.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_fixed.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Fixed Value\" class=\"hierarchy\"/> <a href=\"http://hl7.org/fhir/R4/datatypes-definitions.html#Coding.system\">system</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Identity of the terminology system<br/><span style=\"font-weight: bold\">Fixed Value: </span><a style=\"color: darkgreen\" href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v3-loinc.html\">http://loinc.org</a></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_fixed.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Fixed Value\" class=\"hierarchy\"/> <a href=\"http://hl7.org/fhir/R4/datatypes-definitions.html#Coding.code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Symbol in syntax defined by the system<br/><span style=\"font-weight: bold\">Fixed Value: </span><span style=\"color: darkgreen\">95125-1</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-SARSCoV2AbIgAplusIgMPrThrPtSerPlasordIA-definitions.html#Observation.valueCodeableConcept\">valueCodeableConcept</a><a name=\"Observation.valueCodeableConcept\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Result Value</span><br/><span style=\"font-weight:bold\">Binding: </span><a href=\"ValueSet-covid19-pos-neg-eqvs.html\">Positive/Negative Value Set</a> (<a href=\"http://hl7.org/fhir/R4/terminologies.html#extensible\" title=\"To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.\">extensible</a>)</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/R4/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "http://hl7.org/fhir/us/covid19library/StructureDefinition/SARSCoV2AbIgAplusIgMPrThrPtSerPlasordIA",
"version" : "1.0.0",
"name" : "SARSCoV2AbIgAplusIgMPrThrPtSerPlasordIA",
"title" : "SARS-CoV-2 (COVID19) IgA + IgM [Presence] in Serum or Plasma by Immunoassay",
"status" : "active",
"date" : "2022-07-25T12:22:40+00:00",
"publisher" : "HL7 International - Clinical Information Modeling Initiative",
"contact" : [
{
"name" : "HL7 International - Clinical Information Modeling Initiative",
"telecom" : [
{
"system" : "url",
"value" : "http://hl7.org/Special/committees/cimi"
}
]
},
{
"name" : "Logica",
"telecom" : [
{
"system" : "url",
"value" : "https://www.logicahealth.org/"
}
]
},
{
"name" : "HL7",
"telecom" : [
{
"system" : "url",
"value" : "https://www.hl7.org"
}
]
}
],
"description" : "SARSCoV2AbIgAplusIgMPrThrPtSerPlasordIA is a qualitative test for the SARS-CoV-2 (COVID19) IgA or IgM antibodies via immunoassay in serum or plasma specimens.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"copyright" : "HL7 International & Logica Health, all rights reserved Creative Commons License",
"fhirVersion" : "4.0.1",
"mapping" : [
{
"identity" : "argonaut-dq-dstu2",
"uri" : "http://unknown.org/Argonaut-DQ-DSTU2",
"name" : "Argonaut-DQ-DSTU2"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "sct-concept",
"uri" : "http://snomed.info/conceptdomain",
"name" : "SNOMED CT Concept Domain Binding"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "sct-attr",
"uri" : "http://snomed.org/attributebinding",
"name" : "SNOMED CT Attribute Binding"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "Observation",
"baseDefinition" : "http://hl7.org/fhir/us/covid19library/StructureDefinition/c19-coded-laboratory-observation-base",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Observation",
"path" : "Observation",
"short" : "Measurements and simple assertions",
"definition" : "This profile is created to meet the 2015 Edition Common Clinical Data Set 'Laboratory test(s) and Laboratory value(s)/result(s)' requirements.",
"comment" : "Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.",
"alias" : [
"Vital Signs",
"Measurement",
"Results",
"Tests"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "obs-6",
"severity" : "error",
"human" : "dataAbsentReason SHALL only be present if Observation.value[x] is not present",
"expression" : "dataAbsentReason.empty() or value.empty()",
"xpath" : "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))",
"source" : "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"key" : "obs-7",
"severity" : "error",
"human" : "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present",
"expression" : "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()",
"xpath" : "not(f:*[starts-with(local-name(.), 'value')] and (for $coding in f:code/f:coding return f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value] [f:system/@value=$coding/f:system/@value]))",
"source" : "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"key" : "us-core-2",
"severity" : "error",
"human" : "If there is no component or related element then either a value[x] or a data absent reason must be present",
"expression" : "(component.empty() and related.empty()) implies (dataAbsentReason or value)",
"xpath" : "exists(f:component) or exists(f:related) or exists(f:*[starts-with(local-name(.), 'value)]) or exists(f:dataAbsentReason)",
"source" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "workflow",
"map" : "Event"
},
{
"identity" : "sct-concept",
"map" : "< 363787002 |Observable entity|"
},
{
"identity" : "v2",
"map" : "OBX"
},
{
"identity" : "rim",
"map" : "Observation[classCode=OBS, moodCode=EVN]"
},
{
"identity" : "argonaut-dq-dstu2",
"map" : "Observation"
}
]
},
{
"id" : "Observation.id",
"path" : "Observation.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Observation.meta",
"path" : "Observation.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Meta"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "Observation.implicitRules",
"path" : "Observation.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Observation.language",
"path" : "Observation.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Observation.text",
"path" : "Observation.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "Observation.contained",
"path" : "Observation.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Observation.extension",
"path" : "Observation.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Observation.modifierExtension",
"path" : "Observation.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Observation.identifier",
"path" : "Observation.identifier",
"slicing" : {
"discriminator" : [
{
"type" : "pattern",
"path" : "type"
}
],
"rules" : "open"
},
"short" : "Business Identifier for observation",
"definition" : "A unique identifier assigned to this observation.",
"requirements" : "Allows observations to be distinguished and referenced.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."
},
{
"identity" : "rim",
"map" : "id"
}
]
},
{
"id" : "Observation.identifier:accessionIdentifier",
"path" : "Observation.identifier",
"sliceName" : "accessionIdentifier",
"short" : "Business Identifier for observation",
"definition" : "A unique identifier assigned to this observation.",
"requirements" : "Allows observations to be distinguished and referenced.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."
},
{
"identity" : "rim",
"map" : "id"
}
]
},
{
"id" : "Observation.identifier:accessionIdentifier.id",
"path" : "Observation.identifier.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Observation.identifier:accessionIdentifier.extension",
"path" : "Observation.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Observation.identifier:accessionIdentifier.use",
"path" : "Observation.identifier.use",
"short" : "usual | official | temp | secondary | old (If known)",
"definition" : "The purpose of this identifier.",
"comment" : "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping" : [
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Observation.identifier:accessionIdentifier.type",
"path" : "Observation.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment" : "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"patternCodeableConcept" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "ACSN"
}
]
},
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping" : [
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Observation.identifier:accessionIdentifier.system",
"path" : "Observation.identifier.system",
"short" : "The namespace for the identifier value",
"definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment" : "Identifier.system is always case sensitive.",
"requirements" : "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Observation.identifier:accessionIdentifier.value",
"path" : "Observation.identifier.value",
"short" : "The value that is unique",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment" : "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Observation.identifier:accessionIdentifier.period",
"path" : "Observation.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Observation.identifier:accessionIdentifier.assigner",
"path" : "Observation.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"comment" : "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Observation.identifier:fillerOrderNumber",
"path" : "Observation.identifier",
"sliceName" : "fillerOrderNumber",
"short" : "Business Identifier for observation",
"definition" : "A unique identifier assigned to this observation.",
"requirements" : "Allows observations to be distinguished and referenced.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."
},
{
"identity" : "rim",
"map" : "id"
}
]
},
{
"id" : "Observation.identifier:fillerOrderNumber.id",
"path" : "Observation.identifier.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Observation.identifier:fillerOrderNumber.extension",
"path" : "Observation.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Observation.identifier:fillerOrderNumber.use",
"path" : "Observation.identifier.use",
"short" : "usual | official | temp | secondary | old (If known)",
"definition" : "The purpose of this identifier.",
"comment" : "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping" : [
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Observation.identifier:fillerOrderNumber.type",
"path" : "Observation.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment" : "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"patternCodeableConcept" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "FILL"
}
]
},
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping" : [
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Observation.identifier:fillerOrderNumber.system",
"path" : "Observation.identifier.system",
"short" : "The namespace for the identifier value",
"definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment" : "Identifier.system is always case sensitive.",
"requirements" : "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Observation.identifier:fillerOrderNumber.value",
"path" : "Observation.identifier.value",
"short" : "The value that is unique",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment" : "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Observation.identifier:fillerOrderNumber.period",
"path" : "Observation.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Observation.identifier:fillerOrderNumber.assigner",
"path" : "Observation.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"comment" : "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Observation.identifier:placerOrderNumber",
"path" : "Observation.identifier",
"sliceName" : "placerOrderNumber",
"short" : "Business Identifier for observation",
"definition" : "A unique identifier assigned to this observation.",
"requirements" : "Allows observations to be distinguished and referenced.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "workflow",
"map" : "Event.identifier"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."
},
{
"identity" : "rim",
"map" : "id"
}
]
},
{
"id" : "Observation.identifier:placerOrderNumber.id",
"path" : "Observation.identifier.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Observation.identifier:placerOrderNumber.extension",
"path" : "Observation.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Observation.identifier:placerOrderNumber.use",
"path" : "Observation.identifier.use",
"short" : "usual | official | temp | secondary | old (If known)",
"definition" : "The purpose of this identifier.",
"comment" : "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping" : [
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Observation.identifier:placerOrderNumber.type",
"path" : "Observation.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment" : "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"patternCodeableConcept" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "PLAC"
}
]
},
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping" : [
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Observation.identifier:placerOrderNumber.system",
"path" : "Observation.identifier.system",
"short" : "The namespace for the identifier value",
"definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment" : "Identifier.system is always case sensitive.",
"requirements" : "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Observation.identifier:placerOrderNumber.value",
"path" : "Observation.identifier.value",
"short" : "The value that is unique",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment" : "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Observation.identifier:placerOrderNumber.period",
"path" : "Observation.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Observation.identifier:placerOrderNumber.assigner",
"path" : "Observation.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"comment" : "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Observation.basedOn",
"path" : "Observation.basedOn",
"short" : "Fulfills plan, proposal or order",
"definition" : "A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.",
"requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.",
"alias" : [
"Fulfills"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.basedOn",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/CarePlan",
"http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://hl7.org/fhir/StructureDefinition/NutritionOrder",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"
]
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "workflow",
"map" : "Event.basedOn"
},
{
"identity" : "v2",
"map" : "ORC"
},
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"
}
]
},
{
"id" : "Observation.partOf",
"path" : "Observation.partOf",
"short" : "Part of referenced event",
"definition" : "A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.",
"comment" : "To link an Observation to an Encounter use `encounter`. See the [Notes](http://hl7.org/fhir/R4/observation.html#obsgrouping) below for guidance on referencing another Observation.",
"alias" : [
"Container"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.partOf",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Immunization",
"http://hl7.org/fhir/StructureDefinition/ImagingStudy"
]
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "workflow",
"map" : "Event.partOf"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".outboundRelationship[typeCode=FLFS].target"
}
]
},
{
"id" : "Observation.status",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString" : "default: final"
}
],
"path" : "Observation.status",
"short" : "registered | preliminary | final | amended +",
"definition" : "The status of the result value.",
"comment" : "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"requirements" : "Need to track the status of individual results. Some results are finalized before the whole report is finalized.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Observation.status",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport" : true,
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-status"
},
"mapping" : [
{
"identity" : "workflow",
"map" : "Event.status"
},
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "sct-concept",
"map" : "< 445584004 |Report by finality status|"
},
{
"identity" : "v2",
"map" : "OBX-11"
},
{
"identity" : "rim",
"map" : "status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""
},
{
"identity" : "argonaut-dq-dstu2",
"map" : "Observation.status"
}
]
},
{
"id" : "Observation.category",
"path" : "Observation.category",
"slicing" : {
"discriminator" : [
{
"type" : "pattern",
"path" : "$this"
}
],
"rules" : "open"
},
"short" : "Classification of type of observation",
"definition" : "A code that classifies the general type of observation being made.",
"comment" : "In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set.",
"requirements" : "Used for filtering what observations are retrieved and displayed.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Observation.category",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : &quo r/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
}
],
"key" : "us-core-4",
"severity" : "warning",
"human" : "SHOULD use Snomed CT for coded Results",
"expression" : "valueCodeableConcept.coding.system.empty() or valueCodeableConcept.coding.system = 'http://snomed.info/sct'",
"xpath" : "not(exists(f:valueCodeableConcept/f:coding/f:system) ) or f:valueCodeableConcept/f:coding/f:system[@value='http://snomed.info/sct']",
"source" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"
},
{
"key" : "us-core-3",
"severity" : "error",
"human" : "SHALL use UCUM for coded quantity units.",
"expression" : "valueQuantity.system.empty() or valueQuantity.system = 'http://unitsofmeasure.org'",
"xpath" : "not(exists(f:valueQuantity/f:system) ) or f:valueQuantity/f:system[@value='http://unitsofmeasure.org']",
"source" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/us/covid19library/ValueSet/covid19-pos-neg-eqvs"
},
"mapping" : [
{
"identity" : "sct-concept",
"map" : "< 441742003 |Evaluation finding|"
},
{
"identity" : "v2",
"map" : "OBX.2, OBX.5, OBX.6"
},
{
"identity" : "rim",
"map" : "value"
},
{
"identity" : "sct-attr",
"map" : "363714003 |Interprets|"
},
{
"identity" : "argonaut-dq-dstu2",
"map" : "Observation.value[x]"
}
]
},
{
"id" : "Observation.dataAbsentReason",
"path" : "Observation.dataAbsentReason",
"short" : "Why the result is missing",
"definition" : "Provides a reason why the expected value in the element Observation.value[x] is missing.",
"comment" : "Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"specimen unsatisfactory\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.",
"requirements" : "For many results it is necessary to handle exceptional values in measurements.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.dataAbsentReason",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"obs-6",
"us-core-2"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason"
},
"mapping" : [
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "value.nullFlavor"
},
{
"identity" : "argonaut-dq-dstu2",
"map" : "Observation.dataAbsentReason"
}
]
},
{
"id" : "Observation.interpretation",
"path" : "Observation.interpretation",
"short" : "High, low, normal, etc.",
"definition" : "A categorical assessment of an observation value. For example, high, low, normal.",
"comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.",
"requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.",
"alias" : [
"Abnormal Flag"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.interpretation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationInterpretation"
}
],
"strength" : "extensible",
"description" : "Codes identifying interpretations of observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation"
},
"mapping" : [
{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values|"
},
{
"identity" : "v2",
"map" : "OBX-8"
},
{
"identity" : "rim",
"map" : "interpretationCode"
},
{
"identity" : "sct-attr",
"map" : "363713009 |Has interpretation|"
}
]
},
{
"id" : "Observation.note",
"path" : "Observation.note",
"short" : "Comments about the observation",
"definition" : "Comments about the observation or the results.",
"comment" : "May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.",
"requirements" : "Need to be able to provide free text additional information.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.note",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Annotation"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"
},
{
"identity" : "rim",
"map" : "subjectOf.observationEvent[code=\"annotation\"].value"
}
]
},
{
"id" : "Observation.bodySite",
"path" : "Observation.bodySite",
"short" : "Observed body part",
"definition" : "Indicates the site on the subject's body where the observation was made (i.e. the target site).",
"comment" : "Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. \n\nIf the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension[ bodySite](http://hl7.org/fhir/R4/extension-bodysite.html).",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Observation.bodySite",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "BodySite"
}
],
"strength" : "example",
"description" : "Codes describing anatomical locations. May include laterality.",
"valueSet" : "http://hl7.org/fhir/ValueSet/body-site"
},
"mapping" : [
{
"identity" : "sct-concept",
"map" : "< 123037004 |Body structure|"
},
{
"identity" : "v2",
"map" : "OBX-20"
},
{
"identity" : "rim",
"map" : "targetSiteCode"
},
{
"identity" : "sct-attr",
"map" : "718497002 |Inherent location|"
}
]
},
{
"id" : "Observation.method",
"path" : "Observation.method",
"short" : "How it was done",
"definition" : "Indicates the mechanism used to perform the observation.",
"comment" : "Only used if not implicit in code for Observation.code.",
"requirements" : "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.method",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationMethod"
}
],
"strength" : "example",
"description" : "Methods for simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-methods"
},
"mapping" : [
{
"identity" : "v2",
"map" : "OBX-17"
},
{
"identity" : "rim",
"map" : "methodCode"
}
]
},
{
"id" : "Observation.specimen",
"path" : "Observation.specimen",
"short" : "Specimen used for this observation",
"definition" : "The specimen that was used when this observation was made.",
"comment" : "Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.specimen",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Specimen"
]
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "sct-concept",
"map" : "< 123038009 |Specimen|"
},
{
"identity" : "v2",
"map" : "SPM segment"
},
{
"identity" : "rim",
"map" : "participation[typeCode=SPC].specimen"
},
{
"identity" : "sct-attr",
"map" : "704319004 |Inherent in|"
}
]
},
{
"id" : "Observation.device",
"path" : "Observation.device",
"short" : "(Measurement) Device",
"definition" : "The device used to generate the observation data.",
"comment" : "Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.device",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/DeviceMetric"
]
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "sct-concept",
"map" : "< 49062001 |Device|"
},
{
"identity" : "v2",
"map" : "OBX-17 / PRT -10"
},
{
"identity" : "rim",
"map" : "participation[typeCode=DEV]"
},
{
"identity" : "sct-attr",
"map" : "424226004 |Using device|"
}
]
},
{
"id" : "Observation.referenceRange",
"path" : "Observation.referenceRange",
"short" : "Provides guide for interpretation",
"definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.",
"comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.",
"requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.referenceRange",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "obs-3",
"severity" : "error",
"human" : "Must have at least a low or a high or text",
"expression" : "low.exists() or high.exists() or text.exists()",
"xpath" : "(exists(f:low) or exists(f:high)or exists(f:text))",
"source" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "OBX.7"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"id" : "Observation.referenceRange.id",
"path" : "Observation.referenceRange.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Observation.referenceRange.extension",
"path" : "Observation.referenceRange.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Observation.referenceRange.modifierExtension",
"path" : "Observation.referenceRange.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Observation.referenceRange.low",
"path" : "Observation.referenceRange.low",
"short" : "Low Range, if relevant",
"definition" : "The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.referenceRange.low",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Quantity",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"condition" : [
"obs-3"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "OBX-7"
},
{
"identity" : "rim",
"map" : "value:IVL_PQ.low"
}
]
},
{
"id" : "Observation.referenceRange.high",
"path" : "Observation.referenceRange.high",
"short" : "High Range, if relevant",
"definition" : "The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.referenceRange.high",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Quantity",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
],
"condition" : [
"obs-3"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "OBX-7"
},
{
"identity" : "rim",
"map" : "value:IVL_PQ.high"
}
]
},
{
"id" : "Observation.referenceRange.type",
"path" : "Observation.referenceRange.type",
"short" : "Reference range qualifier",
"definition" : "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.",
"comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.",
"requirements" : "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.referenceRange.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeMeaning"
}
],
"strength" : "preferred",
"description" : "Code for the meaning of a reference range.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-meaning"
},
"mapping" : [
{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"
},
{
"identity" : "v2",
"map" : "OBX-10"
},
{
"identity" : "rim",
"map" : "interpretationCode"
}
]
},
{
"id" : "Observation.referenceRange.appliesTo",
"path" : "Observation.referenceRange.appliesTo",
"short" : "Reference range population",
"definition" : "Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an \"AND\" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.",
"comment" : "This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.",
"requirements" : "Need to be able to identify the target population for proper interpretation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.referenceRange.appliesTo",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationRangeType"
}
],
"strength" : "example",
"description" : "Codes identifying the population the reference range applies to.",
"valueSet" : "http://hl7.org/fhir/ValueSet/referencerange-appliesto"
},
"mapping" : [
{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values| OR \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"
},
{
"identity" : "v2",
"map" : "OBX-10"
},
{
"identity" : "rim",
"map" : "interpretationCode"
}
]
},
{
"id" : "Observation.referenceRange.age",
"path" : "Observation.referenceRange.age",
"short" : "Applicable age range, if relevant",
"definition" : "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.",
"requirements" : "Some analytes vary greatly over age.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.referenceRange.age",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Range"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"
}
]
},
{
"id" : "Observation.referenceRange.text",
"path" : "Observation.referenceRange.text",
"short" : "Text based reference range in an observation",
"definition" : "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of \"normals\".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.referenceRange.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "OBX-7"
},
{
"identity" : "rim",
"map" : "value:ST"
}
]
},
{
"id" : "Observation.hasMember",
"path" : "Observation.hasMember",
"short" : "Related resource that belongs to the Observation group",
"definition" : "This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.",
"comment" : "When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see [Notes](http://hl7.org/fhir/R4/observation.html#obsgrouping) below. Note that a system may calculate results from [QuestionnaireResponse](http://hl7.org/fhir/R4/questionnaireresponse.html) into a final score and represent the score as an Observation.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.hasMember",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/MolecularSequence"
]
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "Relationships established by OBX-4 usage"
},
{
"identity" : "rim",
"map" : "outBoundRelationship"
}
]
},
{
"id" : "Observation.derivedFrom",
"path" : "Observation.derivedFrom",
"short" : "Related measurements the observation is made from",
"definition" : "The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.",
"comment" : "All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see [Notes](http://hl7.org/fhir/R4/observation.html#obsgrouping) below.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.derivedFrom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"http://hl7.org/fhir/StructureDefinition/DocumentReference",
"http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"http://hl7.org/fhir/StructureDefinition/Media",
"http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/MolecularSequence"
]
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "Relationships established by OBX-4 usage"
},
{
"identity" : "rim",
"map" : ".targetObservation"
}
]
},
{
"id" : "Observation.component",
"path" : "Observation.component",
"short" : "Component results",
"definition" : "Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.",
"comment" : "For a discussion on the ways Observations can be assembled in groups together see [Notes](http://hl7.org/fhir/R4/observation.html#notes) below.",
"requirements" : "Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Observation.component",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "containment by OBX-4?"
},
{
"identity" : "rim",
"map" : "outBoundRelationship[typeCode=COMP]"
}
]
},
{
"id" : "Observation.component.id",
"path" : "Observation.component.id",
"representation" : [
"xmlAttr"
],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}
],
"code" : "http://hl7.org/fhirpath/System.String"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Observation.component.extension",
"path" : "Observation.component.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Observation.component.modifierExtension",
"path" : "Observation.component.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Observation.component.code",
"path" : "Observation.component.code",
"short" : "Type of component observation (code / type)",
"definition" : "Describes what was observed. Sometimes this is called the observation \"code\".",
"comment" : "*All* code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.",
"requirements" : "Knowing what kind of observation is being made is essential to understanding the observation.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Observation.component.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationCode"
}
],
"strength" : "example",
"description" : "Codes identifying names of simple observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-codes"
},
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.what[x]"
},
{
"identity" : "sct-concept",
"map" : "< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|"
},
{
"identity" : "v2",
"map" : "OBX-3"
},
{
"identity" : "rim",
"map" : "code"
}
]
},
{
"id" : "Observation.component.value[x]",
"path" : "Observation.component.value[x]",
"short" : "Actual component result",
"definition" : "The information determined as a result of making the observation, if the information has a simple value.",
"comment" : "Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the [Notes section](http://hl7.org/fhir/R4/observation.html#notes) below.",
"requirements" : "An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.component.value[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Quantity"
},
{
"code" : "CodeableConcept"
},
{
"code" : "string"
},
{
"code" : "boolean"
},
{
"code" : "integer"
},
{
"code" : "Range"
},
{
"code" : "Ratio"
},
{
"code" : "SampledData"
},
{
"code" : "time"
},
{
"code" : "dateTime"
},
{
"code" : "Period"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "sct-concept",
"map" : "363714003 |Interprets| < 441742003 |Evaluation finding|"
},
{
"identity" : "v2",
"map" : "OBX.2, OBX.5, OBX.6"
},
{
"identity" : "rim",
"map" : "value"
},
{
"identity" : "sct-attr",
"map" : "363714003 |Interprets|"
}
]
},
{
"id" : "Observation.component.dataAbsentReason",
"path" : "Observation.component.dataAbsentReason",
"short" : "Why the component result is missing",
"definition" : "Provides a reason why the expected value in the element Observation.component.value[x] is missing.",
"comment" : "\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.",
"requirements" : "For many results it is necessary to handle exceptional values in measurements.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Observation.component.dataAbsentReason",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"obs-6"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationValueAbsentReason"
}
],
"strength" : "extensible",
"description" : "Codes specifying why the result (`Observation.value[x]`) is missing.",
"valueSet" : "http://hl7.org/fhir/ValueSet/data-absent-reason"
},
"mapping" : [
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "value.nullFlavor"
}
]
},
{
"id" : "Observation.component.interpretation",
"path" : "Observation.component.interpretation",
"short" : "High, low, normal, etc.",
"definition" : "A categorical assessment of an observation value. For example, high, low, normal.",
"comment" : "Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.",
"requirements" : "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.",
"alias" : [
"Abnormal Flag"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.component.interpretation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ObservationInterpretation"
}
],
"strength" : "extensible",
"description" : "Codes identifying interpretations of observations.",
"valueSet" : "http://hl7.org/fhir/ValueSet/observation-interpretation"
},
"mapping" : [
{
"identity" : "sct-concept",
"map" : "< 260245000 |Findings values|"
},
{
"identity" : "v2",
"map" : "OBX-8"
},
{
"identity" : "rim",
"map" : "interpretationCode"
},
{
"identity" : "sct-attr",
"map" : "363713009 |Has interpretation|"
}
]
},
{
"id" : "Observation.component.referenceRange",
"path" : "Observation.component.referenceRange",
"short" : "Provides guide for interpretation of component result",
"definition" : "Guidance on how to interpret the value by comparison to a normal or recommended range.",
"comment" : "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.",
"requirements" : "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Observation.component.referenceRange",
"min" : 0,
"max" : "*"
},
"contentReference" : "http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange",
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "OBX.7"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Observation",
"path" : "Observation"
},
{
"id" : "Observation.code",
"path" : "Observation.code",
"patternCodeableConcept" : {
"coding" : [
{
"system" : "http://loinc.org",
"code" : "95125-1"
}
]
}
},
{
"id" : "Observation.valueCodeableConcept",
"path" : "Observation.valueCodeableConcept",
"min" : 0,
"max" : "1",
"binding" : {
"strength" : "extensible",
"valueSet" : "http://hl7.org/fhir/us/covid19library/ValueSet/covid19-pos-neg-eqvs"
}
}
]
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.